<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>HibernateGeneralGenericDao xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/hibernate/HibernateGeneralGenericDao.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*****************************************************************************</em></em>
<a name="2" href="#2">2</a>   <em> * HibernateGeneralGenericDao.java - created by aaronz@vt.edu</em>
<a name="3" href="#3">3</a>   <em> * </em>
<a name="4" href="#4">4</a>   <em> * Copyright (c) 2006, 2007, 2008</em>
<a name="5" href="#5">5</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="6" href="#6">6</a>   <em> * </em>
<a name="7" href="#7">7</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="8" href="#8">8</a>   <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="9" href="#9">9</a>   <em> * </em>
<a name="10" href="#10">10</a>  <em> * Contributors:</em>
<a name="11" href="#11">11</a>  <em> * Aaron Zeckoski (aaronz@vt.edu) - primary</em>
<a name="12" href="#12">12</a>  <em> * </em>
<a name="13" href="#13">13</a>  <em> *****************************************************************************/</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.hibernate;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.Serializable;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.ArrayList;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.HashSet;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.Iterator;
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.List;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.Set;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong>import</strong> org.hibernate.criterion.DetachedCriteria;
<a name="25" href="#25">25</a>  <strong>import</strong> org.sakaiproject.genericdao.api.GeneralGenericDao;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em>/**<em>*</em></em>
<a name="28" href="#28">28</a>  <em> * A Hibernate (<a href="http://hibernate.org/)" target="alexandria_uri">http://hibernate.org/)</a> based implementation of GeneralGenericDao</em>
<a name="29" href="#29">29</a>  <em> * which can be extended to add more specialized DAO methods.</em>
<a name="30" href="#30">30</a>  <em> * &lt;p></em>
<a name="31" href="#31">31</a>  <em> * See the overview for installation/usage tips.</em>
<a name="32" href="#32">32</a>  <em> * </em>
<a name="33" href="#33">33</a>  <em> * @author Aaron Zeckoski (aaronz@vt.edu)</em>
<a name="34" href="#34">34</a>  <em> */</em>
<a name="35" href="#35">35</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/genericdao/hibernate/HibernateGeneralGenericDao.html">HibernateGeneralGenericDao</a> <strong>extends</strong> <a href="../../../../org/sakaiproject/genericdao/hibernate/HibernateBasicGenericDao.html">HibernateBasicGenericDao</a> implements <a href="../../../../org/sakaiproject/genericdao/api/GeneralGenericDao.html">GeneralGenericDao</a> {
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <em class="comment">//   public &lt;T> void deleteSet(Set&lt;T> entities) {</em>
<a name="38" href="#38">38</a>  <em class="comment">//      checkEntitySet(entities);</em>
<a name="39" href="#39">39</a>  <em class="comment">//      // TODO - reattach non-persistent objects</em>
<a name="40" href="#40">40</a>  <em class="comment">//      getHibernateTemplate().deleteAll(entities);</em>
<a name="41" href="#41">41</a>  <em class="comment">//   }</em>
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="44" href="#44">44</a>     <strong>public</strong> &lt;T> List&lt;T> findAll(Class&lt;T> entityClass, <strong>int</strong> firstResult, <strong>int</strong> maxResults) {
<a name="45" href="#45">45</a>        DetachedCriteria criteria = DetachedCriteria.forClass(checkClass(entityClass));
<a name="46" href="#46">46</a>        List&lt;T> items = getHibernateTemplate().findByCriteria(criteria, firstResult, maxResults);
<a name="47" href="#47">47</a>        <strong>return</strong> items;
<a name="48" href="#48">48</a>     }
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>     <em class="comment">// OVERRIDES</em>
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>     <em>/**<em>*</em></em>
<a name="54" href="#54">54</a>  <em>    * MUST override this method</em>
<a name="55" href="#55">55</a>  <em>    */</em>
<a name="56" href="#56">56</a>     <strong>protected</strong> &lt;T> <strong>int</strong> baseCountAll(Class&lt;T> type) {
<a name="57" href="#57">57</a>        <strong>return</strong> count(START_QUERY + <span class="string">" "</span> + checkClass(type).getName());
<a name="58" href="#58">58</a>     }
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>     <em>/**<em>*</em></em>
<a name="61" href="#61">61</a>  <em>    * MUST override this method</em>
<a name="62" href="#62">62</a>  <em>    */</em>
<a name="63" href="#63">63</a>     <strong>protected</strong> &lt;T> <strong>int</strong> baseSaveSet(Class&lt;?> type, Set&lt;T> entities) {
<a name="64" href="#64">64</a>        getHibernateTemplate().saveOrUpdateAll(entities);
<a name="65" href="#65">65</a>        <strong>return</strong> entities.size();
<a name="66" href="#66">66</a>     }
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>     <em>/**<em>*</em></em>
<a name="69" href="#69">69</a>  <em>    * MUST override this method</em>
<a name="70" href="#70">70</a>  <em>    */</em>
<a name="71" href="#71">71</a>     <strong>protected</strong> &lt;T> <strong>int</strong> baseDeleteSet(Class&lt;T> type, Serializable[] ids) {
<a name="72" href="#72">72</a>        Set&lt;Object> entities = <strong>new</strong> HashSet&lt;Object>();
<a name="73" href="#73">73</a>        <strong>for</strong> (<strong>int</strong> i = 0; i &lt; ids.length; i++) {
<a name="74" href="#74">74</a>           Object object = baseFindById(type, ids[i]);
<a name="75" href="#75">75</a>           <strong>if</strong> (object != <strong>null</strong>) {
<a name="76" href="#76">76</a>              entities.add(object);
<a name="77" href="#77">77</a>           }
<a name="78" href="#78">78</a>        }
<a name="79" href="#79">79</a>        getHibernateTemplate().deleteAll(entities);
<a name="80" href="#80">80</a>        <strong>return</strong> entities.size();
<a name="81" href="#81">81</a>  <em>/**<em>* This will not flush the item from the session so it is hopeless -AZ</em></em>
<a name="82" href="#82">82</a>  <em>      StringBuilder sb = new StringBuilder();</em>
<a name="83" href="#83">83</a>  <em>      for (int i = 0; i &lt; ids.length; i++) {</em>
<a name="84" href="#84">84</a>  <em>         Object id = ids[i];</em>
<a name="85" href="#85">85</a>  <em>         if (id != null) {</em>
<a name="86" href="#86">86</a>  <em>            if (i > 0) { sb.append(','); }</em>
<a name="87" href="#87">87</a>  <em>            sb.append('?');</em>
<a name="88" href="#88">88</a>  <em>         }</em>
<a name="89" href="#89">89</a>  <em>      }</em>
<a name="90" href="#90">90</a>  <em>      String hql = "delete from "+type.getName()+" entity where entity.id in (" + sb + ")";</em>
<a name="91" href="#91">91</a>  <em>      int deletes = getHibernateTemplate().bulkUpdate(hql, ids);</em>
<a name="92" href="#92">92</a>  <em>      return deletes;</em>
<a name="93" href="#93">93</a>  <em>***/</em>
<a name="94" href="#94">94</a>     }
<a name="95" href="#95">95</a>  
<a name="96" href="#96">96</a>     <em class="comment">// COMMON CODE</em>
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>     <strong>public</strong> &lt;T> List&lt;T> findAll(Class&lt;T> type) {
<a name="99" href="#99">99</a>        <strong>return</strong> findAll(type, 0, 0);
<a name="100" href="#100">100</a>    }
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>    <strong>public</strong> &lt;T> <strong>int</strong> countAll(Class&lt;T> type) {
<a name="103" href="#103">103</a>       checkClass(type);
<a name="104" href="#104">104</a>       <strong>int</strong> count = 0;
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>       <em class="comment">// check the cache first</em>
<a name="107" href="#107">107</a>       <strong>boolean</strong> usedCache = false;
<a name="108" href="#108">108</a>       String searchCacheName = getSearchCacheName(type);
<a name="109" href="#109">109</a>       String cacheKey = <span class="string">"countAll::"</span> + type.getName();
<a name="110" href="#110">110</a>       <strong>if</strong> (getCacheProvider().exists(searchCacheName, cacheKey)) {
<a name="111" href="#111">111</a>          Integer iCount = (Integer) getCacheProvider().get(searchCacheName, cacheKey);
<a name="112" href="#112">112</a>          <strong>if</strong> (iCount != <strong>null</strong>) {
<a name="113" href="#113">113</a>             count = iCount.intValue();
<a name="114" href="#114">114</a>             usedCache = <strong>true</strong>;
<a name="115" href="#115">115</a>          }
<a name="116" href="#116">116</a>       }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>       <strong>if</strong> (! usedCache) {
<a name="119" href="#119">119</a>          count = baseCountAll(type);
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>          <em class="comment">// cache the id results for the search</em>
<a name="122" href="#122">122</a>          getCacheProvider().put(searchCacheName, cacheKey, Integer.valueOf(count));
<a name="123" href="#123">123</a>       }
<a name="124" href="#124">124</a>       <strong>return</strong> count;
<a name="125" href="#125">125</a>    }
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>    <strong>public</strong> &lt;T> <strong>void</strong> deleteSet(Class&lt;T> type, Serializable[] ids) {
<a name="128" href="#128">128</a>       checkClass(type);
<a name="129" href="#129">129</a>       <strong>if</strong> (ids.length > 0) {
<a name="130" href="#130">130</a>          String operation = <span class="string">"deleteSet"</span>;
<a name="131" href="#131">131</a>          beforeWrite(operation, type, ids, <strong>null</strong>);
<a name="132" href="#132">132</a>    
<a name="133" href="#133">133</a>          <strong>int</strong> changes = baseDeleteSet(type, ids);
<a name="134" href="#134">134</a>    
<a name="135" href="#135">135</a>          afterWrite(operation, type, ids, <strong>null</strong>, changes);
<a name="136" href="#136">136</a>    
<a name="137" href="#137">137</a>          <em class="comment">// clear all removed items from the cache</em>
<a name="138" href="#138">138</a>          String cacheName = getCacheName(type);
<a name="139" href="#139">139</a>          <strong>for</strong> (<strong>int</strong> i = 0; i &lt; ids.length; i++) {
<a name="140" href="#140">140</a>             <strong>if</strong> (ids[i] != <strong>null</strong>) {
<a name="141" href="#141">141</a>                String key = ids[i].toString();
<a name="142" href="#142">142</a>                getCacheProvider().remove(cacheName, key);
<a name="143" href="#143">143</a>             }
<a name="144" href="#144">144</a>          }
<a name="145" href="#145">145</a>          <em class="comment">// clear the search caches</em>
<a name="146" href="#146">146</a>          getCacheProvider().clear(getSearchCacheName(type));
<a name="147" href="#147">147</a>       }
<a name="148" href="#148">148</a>    }
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>    <strong>public</strong> &lt;T> <strong>void</strong> saveSet(Set&lt;T> entities) {
<a name="151" href="#151">151</a>       <strong>if</strong> (entities == <strong>null</strong> || entities.isEmpty()) {
<a name="152" href="#152">152</a>          System.out.println(<span class="string">"WARN: Empty list of entities for saveSet, nothing to do..."</span>);
<a name="153" href="#153">153</a>       } <strong>else</strong> {
<a name="154" href="#154">154</a>          Class&lt;?> type = checkEntitySet(entities);
<a name="155" href="#155">155</a>    
<a name="156" href="#156">156</a>          String operation = <span class="string">"saveSet"</span>;
<a name="157" href="#157">157</a>          beforeWrite(operation, type, <strong>null</strong>, entities.toArray());
<a name="158" href="#158">158</a>    
<a name="159" href="#159">159</a>          <strong>int</strong> changes = baseSaveSet(type, entities);
<a name="160" href="#160">160</a>    
<a name="161" href="#161">161</a>          afterWrite(operation, type, <strong>null</strong>, entities.toArray(), changes);
<a name="162" href="#162">162</a>    
<a name="163" href="#163">163</a>          <em class="comment">// clear all saved items from the cache</em>
<a name="164" href="#164">164</a>          String cacheName = getCacheName(type);
<a name="165" href="#165">165</a>          <strong>for</strong> (T t : entities) {
<a name="166" href="#166">166</a>             Object id = baseGetIdValue(t);
<a name="167" href="#167">167</a>             <strong>if</strong> (id != <strong>null</strong>) {
<a name="168" href="#168">168</a>                String key = id.toString();
<a name="169" href="#169">169</a>                getCacheProvider().remove(cacheName, key);
<a name="170" href="#170">170</a>             }
<a name="171" href="#171">171</a>          }
<a name="172" href="#172">172</a>          <em class="comment">// clear the search caches</em>
<a name="173" href="#173">173</a>          getCacheProvider().clear(getSearchCacheName(type));
<a name="174" href="#174">174</a>       }
<a name="175" href="#175">175</a>    }
<a name="176" href="#176">176</a> 
<a name="177" href="#177">177</a>    <strong>public</strong> &lt;T> <strong>void</strong> deleteSet(Set&lt;T> entities) {
<a name="178" href="#178">178</a>       <strong>if</strong> (entities.size() > 0) {
<a name="179" href="#179">179</a>          Class&lt;?> type = checkEntitySet(entities);
<a name="180" href="#180">180</a>          List&lt;Object> ids = <strong>new</strong> ArrayList&lt;Object>();
<a name="181" href="#181">181</a>          <strong>for</strong> (T t : entities) {
<a name="182" href="#182">182</a>             Object id = baseGetIdValue(t);
<a name="183" href="#183">183</a>             <strong>if</strong> (id != <strong>null</strong>) {
<a name="184" href="#184">184</a>                ids.add(id);
<a name="185" href="#185">185</a>             }
<a name="186" href="#186">186</a>          }
<a name="187" href="#187">187</a>          deleteSet(type, ids.toArray(<strong>new</strong> Serializable[ids.size()]));
<a name="188" href="#188">188</a>       }
<a name="189" href="#189">189</a>    }
<a name="190" href="#190">190</a> 
<a name="191" href="#191">191</a>    @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="192" href="#192">192</a>    <strong>public</strong> <strong>void</strong> saveMixedSet(Set[] entitySets) {
<a name="193" href="#193">193</a>       <strong>for</strong> (<strong>int</strong> i=0; i&lt;entitySets.length; i++) {
<a name="194" href="#194">194</a>          checkEntitySet(entitySets[i]);
<a name="195" href="#195">195</a>       }
<a name="196" href="#196">196</a>       <strong>for</strong> (<strong>int</strong> i=0; i&lt;entitySets.length; i++) {
<a name="197" href="#197">197</a>          saveSet(entitySets[i]);
<a name="198" href="#198">198</a>       }
<a name="199" href="#199">199</a>    }
<a name="200" href="#200">200</a> 
<a name="201" href="#201">201</a>    @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="202" href="#202">202</a>    <strong>public</strong> <strong>void</strong> deleteMixedSet(Set[] entitySets) {
<a name="203" href="#203">203</a>       <strong>for</strong> (<strong>int</strong> i=0; i&lt;entitySets.length; i++) {
<a name="204" href="#204">204</a>          checkEntitySet(entitySets[i]);
<a name="205" href="#205">205</a>       }
<a name="206" href="#206">206</a>       <strong>for</strong> (<strong>int</strong> i=0; i&lt;entitySets.length; i++) {
<a name="207" href="#207">207</a>          deleteSet(entitySets[i]);
<a name="208" href="#208">208</a>       }
<a name="209" href="#209">209</a>    }
<a name="210" href="#210">210</a> 
<a name="211" href="#211">211</a>    <em>/**<em>*</em></em>
<a name="212" href="#212">212</a> <em>    * Validates the class type and the list of entities before performing</em>
<a name="213" href="#213">213</a> <em>    * a batch operation (throws IllegalArgumentException)</em>
<a name="214" href="#214">214</a> <em>    * </em>
<a name="215" href="#215">215</a> <em>    * @param entities a Set of persistent entities, should all be of the same type</em>
<a name="216" href="#216">216</a> <em>    */</em>
<a name="217" href="#217">217</a>    <strong>protected</strong> Class&lt;?> checkEntitySet(Set&lt;?> entities) {
<a name="218" href="#218">218</a>       Class&lt;?> entityClass = <strong>null</strong>;
<a name="219" href="#219">219</a>       Iterator&lt;?> it = entities.iterator();
<a name="220" href="#220">220</a>       <strong>while</strong>(it.hasNext()) {
<a name="221" href="#221">221</a>          Object entity = it.next();
<a name="222" href="#222">222</a>          <strong>if</strong> (entityClass == <strong>null</strong>) {
<a name="223" href="#223">223</a>             entityClass = (Class&lt;?>) findClass(entity);
<a name="224" href="#224">224</a>          }
<a name="225" href="#225">225</a>          <strong>if</strong> (! checkClass(entityClass).isInstance(entity)) {
<a name="226" href="#226">226</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Entity set item "</span> +
<a name="227" href="#227">227</a>                   entity.toString() + <span class="string">" is not of type: "</span> + entityClass +
<a name="228" href="#228">228</a>                   <span class="string">", the type is: "</span> + entity.getClass() +
<a name="229" href="#229">229</a>             <span class="string">" (All items must be of consistent persistent type)"</span>);
<a name="230" href="#230">230</a>          }
<a name="231" href="#231">231</a>       }
<a name="232" href="#232">232</a>       <strong>return</strong> entityClass;
<a name="233" href="#233">233</a>    }
<a name="234" href="#234">234</a> 
<a name="235" href="#235">235</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

